<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - sztakipediaTemplate</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

#header
{
	clear: both;
	background-color: white;
	padding: 8px;
	border-bottom: 8px solid #ccc;
	display: block;
	width: 100%;
	line-height: 1.5em;
}

#banner
{
	margin-bottom: 1em;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}

		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
	<div id="banner">
		<a href="http://pedia.sztaki.hu" target="_blank" title="Sztakipedia project"><img src="http://pedia.sztaki.hu/img/sztakilogo.png" alt="Sztakipedia project banner"/></a>
	</div>
	<span style="font-size: 130%;"><a href="http://code.google.com/p/sztakipedia-toolbar/" target="_blank">Sztakipedia toolbar</a> source code documentation</span><br />
	Part of <a href="http://pedia.sztaki.hu/" target="_blank">Sztakipedia project</a> at
	<a href="http://sztaki.hu/" target="_blank">MTA SZTAKI</a>
</div>

		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/SztakipediaClient.html">SztakipediaClient</a></li>
	
	<li><a href="../symbols/SztakipediaTB.html">SztakipediaTB</a></li>
	
	<li><a href="../symbols/sztakipediaTemplate.html">sztakipediaTemplate</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class sztakipediaTemplate
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				Object for cite templates. Stores the information needed to construct template filling dialog windows.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_SztakipediaToolbarBase.js.html">SztakipediaToolbarBase.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class sztakipediaTemplate.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&lt;private&gt; &nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/sztakipediaTemplate.html#constructor">sztakipediaTemplate</a></b>(templatename, shortform, basicfields, expandedfields)
							</div>
							<div class="description"></div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class sztakipediaTemplate.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/sztakipediaTemplate.html#basic">basic</a></b>
								</div>
								<div class="description">Basic fields (e.g.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/sztakipediaTemplate.html#extra">extra</a></b>
								</div>
								<div class="description">Less common - quote, archiveurl - should be everything the template supports minus the basic ones</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/sztakipediaTemplate.html#preview">preview</a></b>
								</div>
								<div class="description">Whether previews are allowed for this template.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/sztakipediaTemplate.html#refs">refs</a></b>
								</div>
								<div class="description">Whether the template is a citation template.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/sztakipediaTemplate.html#shortform">shortform</a></b>
								</div>
								<div class="description">A short form, used for the dropdown box.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/sztakipediaTemplate.html#templatename">templatename</a></b>
								</div>
								<div class="description">The template name - "cite web", "cite book", etc.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class sztakipediaTemplate.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/sztakipediaTemplate.html#getForm">getForm</a></b>()
								</div>
								<div class="description">Makes the form used in the dialog boxes.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/sztakipediaTemplate.html#getInitial">getInitial</a></b>()
								</div>
								<div class="description">Gives a little bit of HTML so the open form can be identified.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/sztakipediaTemplate.html#makeFormInner">makeFormInner</a></b>(fields)
								</div>
								<div class="description">Create a HTML fragment for a form with the given fields as inputs.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">&lt;private&gt; 
						<b>sztakipediaTemplate</b>(templatename, shortform, basicfields, expandedfields)
				</div>
				
				<div class="description">
					
					
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{string}</span>  <b>templatename</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{string}</span>  <b>shortform</b>
								
							</dt>
								<dd></dd>
						
							<dt>
								<span class="light fixedFont">{Object}</span>  <b>basicfields</b>
								
							</dt>
								<dd>Basic fields of the template.</dd>
						
							<dt>
								<span class="light fixedFont">{Object}</span>  <b>expandedfields</b>
								<i>Optional</i>
							</dt>
								<dd>Extra fields of the template. Fields supplied here shall be optional and not present in basic fields.</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name="basic"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>basic</b>
					
					</div>
					<div class="description">
						Basic fields (e.g., author, title, publisher...)
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="extra"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>extra</b>
					
					</div>
					<div class="description">
						Less common - quote, archiveurl - should be everything the template supports minus the basic ones
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="preview"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>preview</b>
					
					</div>
					<div class="description">
						Whether previews are allowed for this template.
Can be set to {@code false} for templates that do not generate output (e.g, PERSONDATA), or would generate too large HTML.
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="refs"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>refs</b>
					
					</div>
					<div class="description">
						Whether the template is a citation template.
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="shortform"> </a>
					<div class="fixedFont">
					
					<span class="light">{string}</span>
					<b>shortform</b>
					
					</div>
					<div class="description">
						A short form, used for the dropdown box.
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="templatename"> </a>
					<div class="fixedFont">
					
					<span class="light">{string}</span>
					<b>templatename</b>
					
					</div>
					<div class="description">
						The template name - "cite web", "cite book", etc.
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="getForm"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>getForm</b>()
					
					</div>
					<div class="description">
						Makes the form used in the dialog boxes.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> a jQuery DOM element</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getInitial"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>getInitial</b>()
					
					</div>
					<div class="description">
						Gives a little bit of HTML so the open form can be identified. 
Also required to interoperate with wikieditor, which checks for {@code $j(...).length == 0} to determine emptiness.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> a jQuery DOM element</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="makeFormInner"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>makeFormInner</b>(fields)
					
					</div>
					<div class="description">
						Create a HTML fragment for a form with the given fields as inputs.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>fields</b>
									
								</dt>
								<dd>The fields to be used for creating input widgets.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object}</span> The jQuery DOM element containing the HTML fragment.</dd>
							
							</dl>
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			&copy; 2011 - MTA SZTAKI <br />
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0
		</div>
	</body>
</html>
